GetPixPat

GetPixPat
Header:	Quickdraw.h		Carbon status:	Supported

Obtains a pixel pattern ('ppat') resource stored in a resource file.

PixPatHandle GetPixPat (
    SInt16 patID
);

Parameter descriptions

patID: The resource ID for a resource of type 'ppat'.

function result

A handle to the pixel pattern having the resource ID you specify in the patID parameter. The GetPixPat function calls the following Resource Manager function with these parameters:

GetResource('ppat', patID);

If a 'ppat' resource with the ID that you request does not exist, the GetPixPat function returns NULL.

DISCUSSION

When you are finished with the pixel pattern, use the DisposePixPat function. For more information on the pixel pattern resource, see 'ppat'.

Pixel patterns can use colors at any pixel depth and can be of any width and height that’s a power of 2. To create a pixel pattern, you typically define it in a 'ppat' resource, which you store in a resource file. To retrieve the pixel pattern stored in a 'ppat' resource, you can use the GetPixPat function.

SPECIAL CONSIDERATIONS

The GetPixPat function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.